package com.qfedu.aunt.commons.config;

import com.google.common.base.Predicates;
import org.springframework.boot.SpringBootConfiguration;
import org.springframework.context.annotation.Bean;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

/**
 * @author xiaobobo
 * @title: Swagger2Config
 * @projectName cd-2209-springboot-parent
 * @description: Swagger的配置
 * @date 2022/10/25  9:46
 */
@SpringBootConfiguration
@EnableSwagger2
public class Swagger2Config {

    @Bean
    public Docket docket(){
        //告诉他这个文档是一个Swagger2的文档
        return new Docket(DocumentationType.SWAGGER_2)
                //设置一个分组的名字这个名字是可以随便写的
                .groupName("auntCommonsApi")
                //这个就是整个API
                .apiInfo(apiInfo())
                //选中的路径都需要生成
                .select()
                //哪些路径不用生成文档
                .paths(Predicates.not(PathSelectors.regex("/admin/.*")))
                .paths(Predicates.not(PathSelectors.regex("/error.*")))
                .build();
    }
    /**
     * 这个位置定义的是整合文档的相关的信息
     * @return
     */
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                //作者信息  公司网站   邮件地址
                .contact(new Contact("小波波","http://www.qfedu.com","402451106@qq.com"))
                //文档的标题
                .title("阿姨来了API接口")
                //文档的描述
                .description("阿姨来了旨在为每一个阿姨提供平等就业的机会")
                //告诉他文档的版本号
                .version("v1.0")
                .build();
    }

}
